---
title: API 参考
description: 完整的 API 参考文档
---

# API 参考

这里是我们的 API 参考文档。

## 核心 API

### `getDocBySlug(slug: string)`

根据 slug 获取文档内容。

**参数:**
- `slug` (string): 文档的 slug

**返回值:**
```typescript
{
  slug: string;
  meta: Record<string, unknown>;
  content: string;
}
```

### `getAllDocs()`

获取所有文档列表。

**返回值:**
```typescript
Doc[]
```

## 示例

```typescript
import { getDocBySlug, getAllDocs } from '@/lib/docs'

// 获取单个文档
const doc = getDocBySlug('hello')

// 获取所有文档
const docs = getAllDocs()
```

## 注意事项

- 所有文档文件必须放在 `src/app/docs/` 目录下
- 文件名将作为 URL 路径
- 支持嵌套目录结构